home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / mintprgs / mintupgr / disk7.zoo / elvis.zoo / usr / doc / elvis / termcap.doc < prev    next >
Text File  |  1992-08-12  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. _1_0.  _T_E_R_M_C_A_P
  8.  
  9.      Elvis uses fairly  standard  termcap  fields  for  most
  10. things.   I  invented  the cursor shape names but other than
  11. that there should be few surprises.
  12.  
  13. _R_e_q_u_i_r_e_d _n_u_m_e_r_i_c _f_i_e_l_d_s
  14.  
  15.         :co#:   number of columns on the screen (chars per line)
  16.         :li#:   number of lines on the screen
  17.  
  18.  
  19. _R_e_q_u_i_r_e_d _s_t_r_i_n_g _f_i_e_l_d_s
  20.  
  21.         :ce=:   clear to end-of-line
  22.         :cl=:   home the cursor & clear the screen
  23.         :cm=:   move the cursor to a given row/column
  24.         :up=:   move the cursor up one line
  25.  
  26.  
  27. _B_o_o_l_e_a_n _f_i_e_l_d_s
  28.  
  29.         :am:    auto margins - wrap when char is written in last column?
  30.         :xn:    brain-damaged auto margins - newline ignored after wrap
  31.         :pt:    physical tabs?
  32.  
  33.  
  34. _O_p_t_i_o_n_a_l _s_t_r_i_n_g _f_i_e_l_d_s
  35.  
  36.         :al=:   insert a blank row on the screen
  37.         :dl=:   delete a row from the screen
  38.         :cd=:   clear to end of display
  39.         :ei=:   end insert mode
  40.         :ic=:   insert a blank character
  41.         :im=:   start insert mode
  42.         :dc=:   delete a character
  43.         :sr=:   scroll reverse (insert row at top of screen)
  44.         :vb=:   visible bell
  45.         :ti=:   terminal initialization string, to start full-screen mode
  46.         :te=:   terminal termination, to end full-screen mode
  47.         :ks=:   enables the cursor keypad
  48.         :ke=:   disables the cursor keypad
  49.  
  50.  
  51. _O_p_t_i_o_n_a_l _s_t_r_i_n_g_s _r_e_c_e_i_v_e_d _f_r_o_m _t_h_e _k_e_y_b_o_a_r_d
  52.  
  53.         :kd=:   sequence sent by the <down arrow> key
  54.         :kl=:   sequence sent by the <left arrow> key
  55.         :kr=:   sequence sent by the <right arrow> key
  56.         :ku=:   sequence sent by the <up arrow> key
  57.         :kP=:   sequence sent by the <PgUp> key
  58.         :kN=:   sequence sent by the <PgDn> key
  59.         :kh=:   sequence sent by the <Home> key
  60.         :kH=:   sequence sent by the <End> key
  61.  
  62.  
  63.  
  64.                       August 10, 1992
  65.  
  66.  
  67.  
  68.  
  69.  
  70. 10-2                      TERMCAP                       10-2
  71.  
  72.  
  73.         :kI=:   sequence sent by the <Insert> key
  74.  
  75.  
  76.      Originally, termcap  didn't  have  any  names  for  the
  77. <PgUp>,  <PgDn>, <Home>, and <End> keys.  Although the capa-
  78. bility names shown in the table above are the  most  common,
  79. they  are  _n_o_t  universal.  SCO Xenix uses :PU=:PD=:HM=:EN=:
  80. for those keys.  Also, if the four arrow keys happen  to  be
  81. part  of  a  3x3 keypad, then the five non-arrow keys may be
  82. named :K1=: through :K5=:, so an  IBM  PC  keyboard  may  be
  83. described  using those names instead.  Elvis can find any of
  84. these names.
  85.  
  86. _O_p_t_i_o_n_a_l _s_t_r_i_n_g_s _s_e_n_t _b_y _f_u_n_c_t_i_o_n _k_e_y_s
  87.  
  88.         :k1=:...:k9=:k0=:       codes sent by <F1> through <F10> keys
  89.         :s1=:...:s9=:s0=:       codes sent by <Shift F1> ... <Shift F10>
  90.         :c1=:...:c9=:c0=:       codes sent by <Ctrl F1> ... <Ctrl F10>
  91.         :a1=:...:a9=:a0=:       codes sent by <Alt F1> ... <Alt F10>
  92.  
  93.  
  94.      Note that :k0=: is used  to  describe  the  <F10>  key.
  95. Some  termcap  documents  recommend  :ka=: or even :k;=: for
  96. describing the <F10> key, but Elvis doesn't support that.
  97.  
  98.      Also, the :s1=:..., :c1=:..., and  :a1=:...  codes  are
  99. very  non-standard.   The  terminfo  library doesn't support
  100. them.
  101.  
  102. _O_p_t_i_o_n_a_l _f_i_e_l_d_s _t_h_a_t _d_e_s_c_r_i_b_e _c_h_a_r_a_c_t_e_r _a_t_t_r_i_b_u_t_e_s
  103.  
  104.         :so=:se=:       start/end standout mode (We don't care about :sg#:)
  105.         :us=:ue=:       start/end underlined mode
  106.         :md=:me=:       start/end boldface mode
  107.         :as=:ae=:       start/end alternate character set (italics)
  108.         :ug#:           visible gap left by :us=:ue=:md=:me=:as=:ae=:
  109.  
  110.  
  111. _O_p_t_i_o_n_a_l _f_i_e_l_d_s _t_h_a_t _a_f_f_e_c_t _t_h_e _c_u_r_s_o_r'_s _s_h_a_p_e
  112.  
  113.      The :cQ=: string is used by  Elvis  immediately  before
  114. exiting  to  undo  the  effects  of  the  other cursor shape
  115. strings.  If :cQ=: is not given, then all other cursor shape
  116. strings are ignored.
  117.  
  118.         :cQ=:   normal cursor
  119.         :cX=:   cursor used for reading EX command
  120.         :cV=:   cursor used for reading VI commands
  121.         :cI=:   cursor used during VI input mode
  122.         :cR=:   cursor used during VI replace mode
  123.  
  124.  
  125.      If the capabilities above aren't given, then Elvis will
  126. try to use the following values instead.
  127.  
  128.  
  129.  
  130.                       August 10, 1992
  131.  
  132.  
  133.  
  134.  
  135.  
  136. 10-3                      TERMCAP                       10-3
  137.  
  138.  
  139.         :ve=:   normal cursor, used as :cQ=:cX=:cI=:cR=:
  140.         :vs=:   gaudy cursor, used as :cV=:
  141.  
  142.  
  143. _A_n _e_x_a_m_p_l_e
  144.  
  145.      Here's the termcap entry I use on my  Minix-ST  system.
  146. Some  of  the  fields  in  it have nothing to do with Elvis.
  147. Some can only work on my system; I have modified my kernel's
  148. screen driver.
  149.  
  150.  
  151. mx|minix|minixst|ansi:\
  152.         :is=\E[0~:co#80:li#25:bs:pt:\
  153.         :cm=\E[%i%d;%dH:up=\E[A:do=^J:nd=\E[C:sr=\EM:\
  154.         :cd=\E[J:ce=\E[K:cl=\E[H\E[J:\
  155.         :al=\E[L:dl=\E[M:ic=\E[@:dc=\E[P:im=:ei=:\
  156.         :so=\E[7m:se=\E[m:us=\E[4m:ue=\E[m:\
  157.         :md=\E[1m:me=\E[m:as=\E[1;3m:ae=\E[m:\
  158.         :ku=\E[A:kd=\E[B:kr=\E[C:kl=\E[D:\
  159.         :k1=\E[1~:k2=\E[2~:k3=\E[3~:k4=\E[4~:k5=\E[5~:\
  160.         :k6=\E[6~:k7=\E[17~:k8=\E[18~:k9=\E[19~:k0=\E[20~:\
  161.         :kU=\E[36~:kQ=\E[32~:kH=\E[28~:\
  162.         :GV=3:GH=D:G1=?:G2=Z:G3=@:G4=Y:GC=E:GL=4:GR=C:GU=A:GD=B:\
  163.         :cQ=\E[k:cX=\E[2;0k:cV=\E[16;0k:cI=\E[k:cR=\E[16;20k:
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.                       August 10, 1992
  197.  
  198.  
  199.